Crate emojis

source ·
Expand description

✨ Lookup and iterate over emoji names, shortcodes, and groups.

Features

  • Lookup up emoji by Unicode value
  • Lookup up emoji by GitHub shortcode (gemoji v4.1.0)
  • Iterate over emojis in recommended order
  • Iterate over emojis in an emoji group, e.g. “Smileys & Emotion” or “Flags”
  • Iterate over the skin tones for an emoji
  • Uses Unicode v15.0 emoji specification

Getting started

First, add the emojis crate to your Cargo manifest.

cargo add emojis

Simply use the get() function to lookup emojis by Unicode value.

let rocket = emojis::get("🚀").unwrap();

Or the get_by_shortcode() function to lookup emojis by gemoji shortcode.

let rocket = emojis::get_by_shortcode("rocket").unwrap();

These operations take Ο(1) time.

MSRV

Currently the minimum supported Rust version is 1.60 due to the dependency on phf. The policy of this crate is to only increase the MSRV in a breaking release.

Examples

The returned Emoji struct has various information about the emoji.

let hand = emojis::get("🤌").unwrap();
assert_eq!(hand.as_str(), "\u{1f90c}");
assert_eq!(hand.name(), "pinched fingers");
assert_eq!(hand.unicode_version(), emojis::UnicodeVersion::new(13, 0));
assert_eq!(hand.group(), emojis::Group::PeopleAndBody);
assert_eq!(hand.shortcode(), Some("pinched_fingers"));
assert_eq!(hand.skin_tone(), Some(emojis::SkinTone::Default));

Another common operation is iterating over the skin tones of an emoji.

let raised_hands = emojis::get("🙌🏼").unwrap();
let skin_tones: Vec<_> = raised_hands.skin_tones().unwrap().map(|e| e.as_str()).collect();
assert_eq!(skin_tones, ["🙌", "🙌🏻", "🙌🏼", "🙌🏽", "🙌🏾", "🙌🏿"]);

You can use the iter() function to iterate over all emojis (only includes the default skin tone versions).

let smiley = emojis::iter().next().unwrap();
assert_eq!(smiley, "😀");

It is recommended to filter the list by the maximum Unicode version that you wish to support.

let iter = emojis::iter().filter(|e| {
    e.unicode_version() < emojis::UnicodeVersion::new(13, 0)
});

Using the Group enum you can iterate over all emojis in a group.

let grapes = emojis::Group::FoodAndDrink.emojis().next().unwrap();
assert_eq!(grapes, "🍇");

See examples/replace.rs for an example that replaces gemoji names in text.

$ echo "launch :rocket:" | cargo run --example replace
launch 🚀

Structs

Enums

Functions

  • get
    Lookup an emoji by Unicode value.
  • get_by_shortcode
    Lookup an emoji by GitHub shortcode.
  • iter
    Returns an iterator over all emojis.